Cards

Cards can be issued to an account or can be non-personalized depending on program configuration. Each account can have a single active card. Card can be either virtual or plastic depending on the program. Cards can be used to pay in any physical location, online or withdraw money from ATMs. All virtual cards are activated upon issuing and can be used immediately. All plastic cards are not activated upon issuing and must be activated by the customer once received. 

All virtual cards are activated upon issuing and can be used immediately. 

All plastic cards are not activated upon issuing and must be activated by the customer once received. 

Cards can be converted from virtual to plastic at a later stage. The PIN can be set on card creation or changed at a later stage on ATM.

Apple Pay/Google Pay push provision is supported depending on the program.

Card Creation

Card creation can require different fields depending on type (virtual, plastic) and affiliation (customer, non-personalized).

Virtual Cards - to create a virtual card associated with a customer account, please include the account identifier and type of card (virtual). In case the name of the merchant/user is not present in the customer profile, please specify them in the emboss name, emboss name line 4, first and last name (for natural persons) fields of the API request.

Plastic Cards - the requirements for plastic card issuing for an account associated with a customer are similar to those for virtual cards. The only addition is to include the delivery details of the cardholder.

The program associated with the account will be used when the card is created. Virtual accounts use the balance of the primary (main) account.

Non-personalized virtual cards - the required fields are program code and type of the card (virtual).

Non-personalized plastic cards - the requirements for non-personalized plastic card issuing are similar to those for non-personalized virtual cards. The only addition is to include the card delivery details.

For all cases above there are additional fields which can be provided like PIN, fulfil and thermal line data. Card 3DS details can also be provided in order for the card to be enrolled immediately after creation.

Please be advised that fulfil and thermal line data usage and placement on the card may vary depending on the personalization bureau. Contact your account manager before usage.

Endpoint

POST   /v2/cards

Operation

card_create

Request Structure

program string (0,any)

account string (0,any)

merchant string (0,any)

Required only for non pesonalized card in case must be assigned to merchant immediately.

user string (0,any)

Required only for non pesonalized card in case must be assigned to user immediately.

aml string (0,any)

Token of AML check. Conditinal: depending on program configuration

emboss_name string (0,any)

emboss_name_line4 string (0,any)

fulfil1 string (0,any)

fulfil2 string (0,any)

thermal_line1 string (0,any)

thermal_line2 string (0,any)

active boolean

pin string (0,any)

type string (0,any)

Available Options: plastic , virtual

first_name string (0,any)

last_name string (0,any)

alias string (0,any)

url string (0,any)

Request


                   
               

           

       

    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Card Conversion

                                        
Virtual cards can be converted to plastic. The requirement for conversion is card delivery details to be present when the virtual card was created or added when making a request to the conversion API endpoint.




                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            PUT  
            /v2/cards/{card}/convert
        

    


    

        
Operation

        

            card_convert
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Card Activation

                                        
Plastic cards are always created not activated, meaning no transactions can be executed with the card before activation. Activation is a one-time process and must be done once the card is received by the cardholder for security reasons.


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            PUT  
            /v2/cards/{card}/activate
        

    


    

        
Operation

        

            card_activate
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
           

           

               
    


                    

                                    Request
                                Structure
            

        
                    

                

                    aml
                    string
                                            (0,any)
                                                        


                
Conditional: For some cases for non personalized cards.


                
                
                            

        

    


           

           

               
Request


               

                   

                   
               

           

       

    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Card Status and Termination

                                        
There are 3 statuses that a card can have:



                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                    

                                                                                                                                                                                    

                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                                                            

                                    

                                                                                                                                


                                                                                
{ PUT }

                                        


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            PUT  
            /v2/cards/{card}/status
        

    


    

        
Operation

        

            card_status
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
           

           

               
    


                    

                                    Request
                                Structure
            

        
                    

                

                    status
                    string
                                            (0,any)
                                                        


                


                                    Available Options:  active , inactive
                
                
                            

        

    


           

           

               
Request


               

                   

                   
               

           

       

    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
{ DELETE }

                                        


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            DELETE  
            /v2/cards/{card}
        

    


    

        
Operation

        

            card_terminate
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Card Limits and Fees

                                        
By default, limit and fee groups are set upon card creation depending on program configuration. Each limit/fee group can be changed or removed at any time.

The group codes will be provided by Paynetics and must be associated with the program, or the change will not be executed.



                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            PUT  
            /v2/cards/{card}/groups
        

    


    

        
Operation

        

            card_groups
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
           

           

               
    


                    

                                    Request
                                Structure
            

        
                    

                

                    usage
                    string
                                            (0,any)
                                                        


                


                
                
                            

                    

                

                    fees
                    string
                                            (0,any)
                                                        


                


                
                
                            

                    

                

                    schedule_fees
                    string
                                            (0,any)
                                                        


                


                
                
                            

                    

                

                    web_service_fees
                    string
                                            (0,any)
                                                        


                


                
                
                            

                    

                

                    limits
                    string
                                            (0,any)
                                                        


                


                
                
                            

                    

                

                    linkage
                    string
                                            (0,any)
                                                        


                


                
                
                            

                    

                

                    mcc
                    string
                                            (0,any)
                                                        


                


                
                
                            

                    

                

                    whitelist
                    string
                                            (0,any)
                                                        


                


                
                
                            

        

    


           

           

               
Request


               

                   

                   
               

           

       

    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Card PIN Management

                                        
Card PIN can be retrieved using API at any time.


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                                                            

                                    

                                                                                                                                


                                                                                
{ GET }

                                        


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            GET  
            /v2/cards/{card}/pin
        

    


    

        
Operation

        

            card_retrieve_pin
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                                                                                                                                        


                                                                                
{ POST }

                                        
It can be sent to the cardholder via SMS depending on the program configuration. The mobile phone number added upon card creation will be used. In case the phone number must be changed please use the cardholder details update API.


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            POST  
            /v2/cards/{card}/pin/send
        

    


    

        
Operation

        

            card_send_pin
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
{ DELETE }

                                        
Error counter can be reset using API. This is needed in case the cardholder has entered an incorrect PIN/CVV several times on POS, ATM or online.


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            DELETE  
            /v2/cards/{card}/pin/reset
        

    


    

        
Operation

        

            card_reset_pin
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Card 3DS Enrollment

                                        
Card can be enrolled for 3DS for both OTP SMS authentication and/or biometric authentication. For OTP SMS authentication the mobile phone number of the account holder is required.




                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            POST  
            /v2/cards/{card}/3ds
        

    


    

        
Operation

        

            card_3ds_enrol
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
           

           

               
    


                    

                                    Request
                                Structure
            

        
                    

                

                    otp_sms
                    string
                                            (0,any)
                                                        


                


                
                
                            

                    

                

                    biometric
                    boolean
                                                        


                


                
                
                            

        

    


           

           

               
Request


               

                   

                   
               

           

       

    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Enrolment mobile phone

                                        
 * number can be amended at a later stage.


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            PUT  
            /v2/cards/{card}/3ds
        

    


    

        
Operation

        

            card_3ds_update
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
           

           

               
    


                    

                                    Request
                                Structure
            

        
                    

                

                    otp_sms
                    string
                                            (0,any)
                                                        


                


                
                
                            

        

    


           

           

               
Request


               

                   

                   
               

           

       

    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Enrolment for both types

                                        
* can be disabled at any time but is not recommended.


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            DELETE  
            /v2/cards/{card}/3ds
        

    


    

        
Operation

        

            card_3ds_remove
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
           

           

               
    


                    

                                    Request
                                Structure
            

        
                    

                

                    type
                    string
                                            (0,any)
                                                        


                


                
                
                            

        

    


           

           

               
Request


               

                   

                   
               

           

       

    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                


                                                                                
List / detail

                                        
Something about list and detail


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                                                            

                                    

                                                                                                                                


                                                                                
List

                                        


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            GET  
            /v2/cards/{page}/{limit}
        

    


    

        
Operation

        

            cards_list
        

    


    
        

            
Parameters


            

                                    
[ page ]


                    


                    

                                    
[ limit ]


                    


                    

                            

        


    
            

            
Filters


            

                                   

                       merchant -  (Token of merchant)
                   

                                   

                       user -  (Token of user)
                   

                            

        


    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Detail

                                        


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            GET  
            /v2/cards/{card}
        

    


    

        
Operation

        

            card_details
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Number & CVV

                                        



                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                                                            

                                    

                                                                                                                                


                                                                                
Firs half

                                        


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            GET  
            /v2/cards/{card}/first-half
        

    


    

        
Operation

        

            card_number
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response


                

                    

                    
                

            

        

    
    


                                                                            

                                    

                                                                                                                                


                                                                                
Second half

                                        


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                        
                                        
                                        
                                                                                        


    

        
Endpoint

        

            GET  
            /v2/cards/{card}/second-half
        

    


    

        
Operation

        

            card_number
        

    


    
        

            
Parameters


            

                                    
[ card ]


                    


                    
Token from card creation

                            

        


    
    
    
            

            

                
    


                    

                                    Response
                                Structure
            

        
                    

                

                    code
                    integer
                                            (0,any)
                                                        


                


                
                
                            

        

    


            

            

                
Response